Saltar para o conteúdo principal
GET
[BETA] Get Campaign Products Report.

Autorizações

Authorization
string
header
obrigatório

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Parâmetros de caminho

campaign-id
string<uuid>
obrigatório

The ID of the campaign.

Parâmetros de consulta

start_date
string<date>
obrigatório

The start date for which reports will be generated.

end_date
string<date>
obrigatório

The end date for which reports will be generated.

The search string for a given query.

next_page
string | null

Token for retrieving the next page.

limit
integer
padrão:100

Maximum number of products to retrieve.

Intervalo necessário: 1 <= x <= 100

Resposta

Successful Response

hasMore
boolean
obrigatório

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

products
GlobalCatalogProductKpi · object[]
obrigatório
nextPage
string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1
Exemplo:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="